home *** CD-ROM | disk | FTP | other *** search
/ The World of Computer Software / The World of Computer Software.iso / qwkit10.zip / QWKIT.DOC < prev    next >
Text File  |  1993-01-04  |  19KB  |  526 lines
  1.  
  2.  
  3.                               Qwkit 1.0
  4.  
  5.                            Tagline Manager,
  6.                             Message Filter,
  7.                           Message Signatures,
  8.                               and more...
  9.  
  10.                          For QWK Mail Readers
  11.  
  12.                           Copyright (c) 1993
  13.                              by Lyman Epp
  14.  
  15.             ┌──────────╖
  16.             │  ╔════╕  ║
  17.             │  ║    │  ║ ┌─╖   ┌─╖ ┌─╖ ┌──╖ ┌───╖ ┌─────╖
  18.             │  ║    │  ║ │ ║   │ ║ │ ║┌┘ ╔╝ ╘╕ ╔╝ ╘═╕ ╔═╝
  19.             │  ║    │  ║ │ ║┌─╖│ ║ │ ╙┘ ╙─╖  │ ║    │ ║
  20.             │  ║ ┌─╖│  ║ │ ║│ ║│ ║ │ ╔══╕ ║  │ ║    │ ║
  21.             │  ╙─┘ ╙┘  ║ │ ╙┘ ╙┘ ║ │ ║  │ ║ ┌┘ ╙╖   │ ║
  22.             ╘═════╕ ╔══╝ ╘═══════╝ ╘═╝  ╘═╝ ╘═══╝   ╘═╝
  23.                   ╘═╝
  24.  
  25.  
  26.  
  27. WHAT IS QWKIT?
  28. ---------------
  29. Qwkit is a utility that will enhance your current QWK mail reader.
  30. Support is currently limited to SLMR, OLX and MegaMail (other readers
  31. may work with Qwkit and may be supported in the future).  Qwkit works
  32. automatically, set it up and forget that it's there!
  33.  
  34. How will Qwkit enhance my current mail reader?  Qwkit ...
  35.  
  36. ... includes a completely automated tagline stealer.  Now you don't
  37.     have to think of your own witty taglines.  See TAGLINE_ID,
  38.     IGNORE_ID and NEWTAGS options.
  39.  
  40. ... replaces your current mail reader's limited taglines with support
  41.     for practically unlimited taglines.  You'll have plenty of
  42.     taglines when you use the tagline stealer!  See TAGLINES option.
  43.  
  44. ... filters messages by name or subject for inclusion and exclusion
  45.     from your QWK packets.  This can function as a twit filter and
  46.     much more.  See INCLUDE and EXCLUDE options.
  47.  
  48. ... adds your customized signature(s) to messages.  Makes your
  49.     messages more "personalized".  See SIGNATURE option.
  50.  
  51. ... keeps a cumulative log of new files for each BBS.  Be sure to
  52.     give this feature a try!  See NEWFILES option.
  53.  
  54. ... strip Re: and (R) subject prefixes.  Makes reading messages by
  55.     subject easier.  See STRIP_RE option.
  56.  
  57.  
  58. Each of these features can be selectively enabled and disabled.
  59.  
  60.  
  61.  
  62. WHAT'S THE CATCH?
  63. -----------------
  64. Qwkit does not provide a flashy user interface.  It works by
  65. intercepting calls to PKZIP and PKUNZIP from your mail reader.  You
  66. will not see the taglines or signatures that Qwkit is adding to your
  67. messages.  They will be inserted into your messages just before the
  68. REP packet is created.  This means that you won't be able to select
  69. taglines and signatures for each message.
  70.  
  71.  
  72.  
  73. GUILT-FREE SHAREWARE AGREEMENT
  74. ------------------------------
  75. Qwkit is shareware.  If you find that Qwkit is useful and you would
  76. like to help support it's development, then please send a $10
  77. donation.  With your donation comes the satisfaction of knowing that
  78. you're helping support a great shareware product.
  79.  
  80.   Send your donation to:
  81.   ~~~~~~~~~~~~~~~~~~~~~~
  82.     Lyman Epp
  83.     PO Box 371121
  84.     Omaha, NE 68137-6121
  85.  
  86.  
  87.  
  88. BBS SUPPORT
  89. -----------
  90. The Online Pitstop has been gracious enough to host the Qwkit Support
  91. forum.  If you want to download the latest version, ask a question, or
  92. make a suggestion for a future release, your best chance will be to
  93. call The Online Pitstop.  You will be allowed immediate, free access
  94. to the Qwkit Support forum.  Please drop the SYSOP a note thanking him
  95. for hosting Qwkit Support!  I also monitor the RIME Offline Mail
  96. Readers forum and the RIME Common forum (find a RIME affiliated BBS
  97. near you).
  98.  
  99.   The Online Pitstop
  100.   ~~~~~~~~~~~~~~~~~~
  101.     (402) 292-3637  CompuCom & 2400
  102.     (402) 292-8924  V.32 & V.32bis
  103.     (402) 292-3753  HST DS 16.8
  104.  
  105.  
  106.  
  107. INSTALLING QWKIT
  108. -----------------
  109. 1.  Create a sub-directory for Qwkit.  Suggested is C:\QWKIT.  Copy
  110.     files from the ZIP file to this directory.
  111.  
  112. 2.  Use a text editor to create a QWKIT.CFG configuration file in the
  113.     directory created in step #1.  See format of configuration file
  114.     below (or use the sample configuration file).  If you use the
  115.     sample config file, be sure to specify the correct paths for
  116.     PKZIP and PKUNZIP.
  117.  
  118. 3.  Use the CONFIG program included with this release.  It will
  119.     configure your mail reader to use Qwkit.  Please read the proper
  120.     section for your mail reader.  Be sure to execute CONFIG from the
  121.     directory that Qwkit is installed in (see step #1).  The CONFIG
  122.     program will not change the QWKIT.CFG file, it will only change
  123.     your mail reader's configuration.
  124.  
  125.  
  126.     MegaRead V2.1
  127.     -------------
  128.     CONFIG will update the "PKZIP", "PKUNZIP" and "Swap when zipping"
  129.     configuration options.  When you look at MegaRead's "PKZIP" or
  130.     "PKUNZIP" options, MegaRead will automatically search for
  131.     PKZIP.EXE or PKUNZIP.EXE.  This will disable Qwkit!  If this
  132.     happens, just repeat step #3 to re-enable Qwkit.
  133.  
  134.     CONFIG must be able to locate MEGAREAD.EXE in one of the following
  135.     locations:
  136.     o   Current directory
  137.     o   PATH statement
  138.     o   C:\MEGAMAIL
  139.  
  140.     If MEGAREAD.EXE isn't located in one of these locations, CONFIG
  141.     will not be able to continue.  If MEGAREAD.EXE isn't in your PATH
  142.     statement and it's not in C:\MEGAMAIL, then change to the
  143.     directory that MEGAREAD.EXE is located in and specify a complete
  144.     path when starting CONFIG.  For example:
  145.  
  146.     C> CD \MYDIR
  147.     C> \QWKIT\CONFIG
  148.  
  149.     Qwkit will not process MegaMail format mail packets (UL/DL).  It
  150.     will only process QWK and REP packets within MegaRead.
  151.  
  152.  
  153.     Silly Little Mail Reader V2.1 (SLMR)
  154.     ------------------------------------
  155.     CONFIG will change the "ZIP", "UNZIP" and "SWAP" configuration
  156.     options.
  157.  
  158.     CONFIG must be able to locate SLMR.EXE in one of the following
  159.     locations:
  160.     o   Current directory
  161.     o   PATH statement
  162.     o   C:\SLMR
  163.  
  164.     If SLMR.EXE isn't located in one of these locations, CONFIG
  165.     will not be able to continue.  If SLMR.EXE isn't in your PATH
  166.     statement and it's not in C:\SLMR, then change to the directory
  167.     that SLMR.EXE is located in and specify a complete path when
  168.     starting CONFIG.  For example:
  169.  
  170.     C> CD \MYDIR
  171.     C> \QWKIT\CONFIG
  172.  
  173.  
  174.     Offline Xpress V2.2 (OLX)
  175.     -------------------------
  176.     CONFIG will change the "ZIP", "UNZIP" and "SWAP" configuration
  177.     options.
  178.  
  179.     CONFIG must be able to locate OLX.EXE in one of the following
  180.     locations:
  181.     o   Current directory
  182.     o   PATH statement
  183.     o   C:\OLX
  184.  
  185.     If OLX.EXE isn't located in one of these locations, CONFIG
  186.     will not be able to continue.  If OLX.EXE isn't in your PATH
  187.     statement and it's not in C:\OLX, then change to the directory
  188.     that OLX.EXE is located in and specify a complete path when
  189.     starting CONFIG.  For example:
  190.  
  191.     C> CD \MYDIR
  192.     C> \QWKIT\CONFIG
  193.  
  194.  
  195.     Other Mail Readers
  196.     ------------------
  197.     Other mail readers may be supported by Qwkit.  If your mail
  198.     reader allows you to specify the path for PKZIP and PKUNZIP then
  199.     try changing the PKZIP path to C:\QWKIT\QWKIT.EXE and the PKUNZIP
  200.     path to C:\QWKIT\UNQWKIT.EXE (substitute the path where you
  201.     installed Qwkit).  If your mail reader has a "Swap When Zipping"
  202.     option, then set the option to "yes".  This is known to work with
  203.     Deluxe² V2.15.  Please drop me a note indicating your success or
  204.     failure with a particular mail reader.
  205.  
  206.  
  207.  
  208. QWKIT CONFIGURATION OPTIONS
  209. ----------------------------
  210. The Qwkit configuration file is composed of keywords and parameters.
  211. You will need to use a text editor to create the configuration file.
  212. The configuration file is not case-sensitive, unless otherwise noted.
  213. Blank lines are ignored.  Whitespace before and after the keyword is
  214. ignored.  White-space before and after the "=" sign is ignored.  Refer
  215. to the sample configuration file for further information.  The valid
  216. keywords are:
  217.  
  218.     * [comment]
  219.  
  220.         Any lines that begin with "*" are considered comments.
  221.  
  222.     PKZIP = [path][filename]
  223.  
  224.         Specify the filename of PKZIP.EXE.  The path is optional and
  225.         if it is missing, the PATH environment variable will be
  226.         searched.  This keyword is required.
  227.  
  228.     PKUNZIP = [path][filename]
  229.  
  230.         Specify the filename of PKUNZIP.EXE.  The path is optional and
  231.         if it is missing, the PATH environment variable will be
  232.         searched.  This keyword is required.
  233.  
  234.     FIDO = [Yes|NO]
  235.  
  236.         Specify "Yes" or "No" for FIDO compatibility.  Some networks
  237.         (like FIDO) do not allow the use of non-ASCII characters.
  238.         This option will replace the non-ASCII "■" character in
  239.         Qwkit's taglines with the more acceptable "*" character.
  240.         You don't need to use this option unless you are on a FIDO
  241.         network and you are using the TAGLINES= option.  This keyword
  242.         will default to "No".
  243.  
  244.     STRIP_RE = [YES|No]
  245.  
  246.         Specify "Yes" or "No" for stripping Re: and (R) subject
  247.         prefixes.  This can make reading messages by subject easier
  248.         in some mail readers.  This keyword will default to "Yes".
  249.  
  250.     LOGFILE = [filename]
  251.  
  252.         Specify fully qualified filename of log and enable logging.
  253.         Qwkit will log the following items:
  254.         o   Purged message information
  255.         o   Possible new taglines for IGNORE_ID and TAGLINE_ID
  256.         o   Summary of messages processed/purged and taglines stolen
  257.         This keyword is optional.
  258.  
  259.     TAGLINES = [filename]
  260.  
  261.         Specify fully qualified filename for taglines.  If this
  262.         keyword specified, then your mail reader's taglines will be
  263.         replaced with taglines read from this file.  There isn't
  264.         really any limit to the number of taglines in this file.
  265.         The first tagline is selected at random and taglines are used
  266.         sequentially from that point.  This keyword is optional.
  267.  
  268.     SIGNATURE = [filename]
  269.  
  270.         Specify fully qualified filename containing your signature.
  271.         The contents of this file will be added after the message
  272.         body and before the tagline.  You can specify a maximum of
  273.         100 SIGNATURE keywords.  The total combined size of all
  274.         signatures cannot exceed 4096 bytes.  The first signature is
  275.         selected at random and signatures are used sequentially from
  276.         that point.  This keyword is optional.
  277.  
  278.     NEWFILES = [path]
  279.  
  280.         The contents of the NEWFILES.DAT will be appended to the
  281.         BBSID.NEW file in the path you specify (BBSID will be
  282.         replaced with the BBS name for each QWK packet).  Qwkit will
  283.         add a date and time stamp before appending.  This keyword is
  284.         optional.
  285.  
  286.     NEWTAGS = [filename]
  287.  
  288.         Specify fully qualified filename for stolen taglines.  This
  289.         option enables the automated tagline stealer.  This must be
  290.         combined with one or more IGNORE_ID and/or TAGLINE_ID
  291.         keywords.  This keyword is optional.
  292.  
  293.     IGNORE_ID = [text]
  294.  
  295.         Specify text to ignore when searching for taglines.  This
  296.         would typically contain network routing information.  Case and
  297.         whitespace are significant within [text].  You don't need to
  298.         create an IGNORE_ID for FIDO-style taglines -- Qwkit will
  299.         consider a non-ASCII character within an IGNORE_ID to be the
  300.         same as "*".  You can specify a maximum of 100 IGNORE_ID
  301.         keywords.
  302.  
  303.     TAGLINE_ID = [text]
  304.  
  305.         Specify text to identify taglines.  This is how Qwkit
  306.         identifies and steals taglines.  This option is also used
  307.         by Qwkit to replace your mail reader's tagline.  Qwkit will
  308.         assist you in creating TAGLINE_ID's by identifying possible
  309.         new taglines in the log file (only if logging is active).
  310.         Case and whitespace are significant within [text].  You don't
  311.         need to create a TAGLINE_ID for FIDO-style taglines -- Qwkit
  312.         will consider a non-ASCII character within a TAGLINE_ID to be
  313.         the same as "*".  You can specify a maximum of 100 TAGLINE_ID
  314.         keywords.
  315.  
  316.     EXCLUDE = [bbsid]:[conference]:[user]:[subject]
  317.     INCLUDE = [bbsid]:[conference]:[user]:[subject]
  318.  
  319.         Enables message filtering by bbsid, conference, user and
  320.         subject.  EXCLUDE and INCLUDE keywords are processed in the
  321.         order that they are specified in the configuration file.  You
  322.         can have multiple keywords that affect the same message, but
  323.         only the last keyword matching the criteria will determine
  324.         whether the message is included or excluded (see the sample
  325.         configuration file).  Wildcards are allowed using "*" and "?"
  326.         characters.  Case and whitespace are ignored within all
  327.         parameters.  You may specify "YOU" for 'user' instead of your
  328.         name.  There is a combined limit of 200 EXCLUDE and INCLUDE
  329.         keywords.
  330.  
  331.  
  332.  
  333. SAMPLE CONFIGURATION FILE
  334. -------------------------
  335. *
  336. *  Qwkit is Copyright (c) 1993 by Lyman Epp
  337. *
  338. PKZIP      = PKZIP
  339. PKUNZIP    = PKUNZIP
  340. SIGNATURE  = C:\QWKIT\SAMPLE1.SIG
  341. SIGNATURE  = C:\QWKIT\SAMPLE2.SIG
  342. TAGLINES   = C:\QWKIT\TAGLINES.TXT
  343. LOGFILE    = C:\QWKIT\QWKIT.LOG
  344. NEWFILES   = C:\QWKIT\
  345. NEWTAGS    = C:\QWKIT\NEWTAGS.TXT
  346. FIDO       = NO
  347. STRIP_RE   = YES
  348. *
  349. *  Teach Qwkit how to steal taglines!
  350. *
  351. IGNORE_ID  =  SFUTI
  352. IGNORE_ID  = JetMail
  353. IGNORE_ID  = PCRelay:
  354. IGNORE_ID  = RBBS-UTI
  355. IGNORE_ID  = ■ BCSUTI
  356. IGNORE_ID  = ■ Cam-Mail
  357. IGNORE_ID  = ■ CNet
  358. IGNORE_ID  = ■ ILink
  359. IGNORE_ID  = ■ JNet
  360. IGNORE_ID  = ■ KMail
  361. IGNORE_ID  = ■ MetroMail
  362. IGNORE_ID  = ■ MjrUTI
  363. IGNORE_ID  = ■ MSI
  364. IGNORE_ID  = ■ Origin:
  365. IGNORE_ID  = ■ PCBoard
  366. IGNORE_ID  = ■ PostLink
  367. IGNORE_ID  = ■ QNet
  368. IGNORE_ID  = ■ RNet
  369. IGNORE_ID  = ■ SFMail
  370. IGNORE_ID  = ■ SPITFIRE
  371. IGNORE_ID  = ■ TNet
  372. IGNORE_ID  = ■ Via ProDoor
  373. IGNORE_ID  = ■ Via ProEdit
  374. IGNORE_ID  = ■ WildNet
  375. TAGLINE_ID = ■ 1st
  376. TAGLINE_ID = ■ DeLuxe
  377. TAGLINE_ID = ■ EZ
  378. TAGLINE_ID = ■ JABBER
  379. TAGLINE_ID = ■ KingQWK
  380. TAGLINE_ID = ■ KWQ/2
  381. TAGLINE_ID = ■ MegaMail
  382. TAGLINE_ID = ■ MR/2
  383. TAGLINE_ID = ■ OLX
  384. TAGLINE_ID = ■ PMDBM
  385. TAGLINE_ID = ■ PMQWK
  386. TAGLINE_ID = ■ PQ
  387. TAGLINE_ID = ■ QMPro
  388. TAGLINE_ID = ■ Qwkit
  389. TAGLINE_ID = ■ RoboMail
  390. TAGLINE_ID = ■ RoseReader
  391. TAGLINE_ID = ■ SLMR
  392. TAGLINE_ID = ■ SM
  393. TAGLINE_ID = ■ SPEED
  394. TAGLINE_ID = ■ TLX
  395. TAGLINE_ID = ■ TMR
  396. TAGLINE_ID = ■ WinQwk
  397. TAGLINE_ID = ■ XRS!
  398. TAGLINE_ID = ■ ≡OLX≡
  399. *
  400. *  Sample Qwkit message filters.  Uncomment to use.
  401. *
  402. *            BBSID      CONFERENCE   USER NAME         SUBJECT
  403. *
  404. *EXCLUDE    = *        : *          : JANE DOE        : *
  405. *EXCLUDE    = MYBBS    : IDIOT      : BOB *           : *
  406. *EXCLUDE    = *        : DEBATE     : *               : *ELECTION*
  407. *INCLUDE    = *        : *          : YOU             : *
  408. *
  409. *  This is a simple trick for mail doors that don't allow you to
  410. *  select only mail to YOU or ALL.  This first excludes all messages
  411. *  and then includes messages to ALL and excludes messages with
  412. *  subjects that you don't want to read and then includes all
  413. *  messages to you.  Uncomment to use.
  414. *
  415. *EXCLUDE    = *        : 4-$ALE     : *               : *
  416. *INCLUDE    = *        : 4-$ALE     : ALL             : *
  417. *EXCLUDE    = *        : 4-$ALE     : *               : *286*
  418. *EXCLUDE    = *        : 4-$ALE     : *               : *Nintendo*
  419. *INCLUDE    = *        : 4-$ALE     : YOU             : *
  420.  
  421.  
  422.  
  423. QUESTIONS AND ANSWERS
  424. ---------------------
  425. Q.  What are the BBSID.___ files that Qwkit creates?
  426. A.  Qwkit creates these files to avoid stealing taglines from the
  427.     same QWK packet more than once.  This is very useful in SLMR and
  428.     OLX where you can open the same QWK packet repeatedly.
  429.  
  430. Q.  Why doesn't Qwkit work when I disable the swapping option in my
  431.     mail reader?
  432. A.  The swapping option is almost always required when using Qwkit.
  433.     When swapping is disabled, the following programs will all try to
  434.     be in memory at the same time.
  435.         Your Mail Reader  -->  Qwkit  -->  PKZIP/PKUNZIP
  436.  
  437. Q.  Can I use LHARC or ARJ to create my mail packets?
  438. A.  No, Qwkit only supports PKZIP at this time.
  439.  
  440. Q.  I have one of the supported mail readers, but Qwkit doesn't seem
  441.     to work with it.
  442. A.  Qwkit only supports specific versions of each mail reader.
  443.     Check to make sure that you're using the correct version of the
  444.     mail reader (see installation instructions).
  445.  
  446. Q.  What if my mail reader isn't supported by Qwkit?
  447. A.  It doesn't hurt to try it.  Read the "Other Mail Readers" section
  448.     in the installation instructions.
  449.  
  450. Q.  Why can't I steal taglines from the Blue Wave reader?
  451. A.  It uses it's own format for taglines (the tagline appears on the
  452.     line after the mail reader's signature).
  453.  
  454.  
  455.  
  456. CREDITS
  457. -------
  458. Silly Little Mail Reader and SLMR are trademarks of Greg Hewgill.
  459. Offline Xpress and OLX are trademarks of Mustang Software, Inc.
  460. MegaMail is a trademark of Kip Compton.
  461. PKZIP and PKUNZIP are trademarks of PKWARE Inc.
  462.  
  463.  
  464.  
  465. THANKS TO
  466. ---------
  467. ... a great group of beta testers!  Special thanks to Jim Logan,
  468. Chau Pham and Robert Savery.  Thanks also go to Robert Beagle, Sam
  469. Bennett, Lori Wilson and Dennis Craig.  These folks have helped
  470. refine Qwkit into what it is today.
  471.  
  472. ... Robert Beagle for hosting the Qwkit Support and Beta forums on
  473. the Online Pitstop.  This is one great BBS!
  474.  
  475.  
  476.  
  477. FUTURE VERSIONS
  478. ---------------
  479. If there is enough support for Qwkit....  Future versions may include
  480. some of the following ideas.
  481.  
  482. o   Support for LHA, ARJ and PAK.
  483. o   Support for other mail readers (DeLuxe, 1st Reader, Speed, etc).
  484. o   Support for MegaMail format mail packets (UL/DL).
  485. o   Your ideas!  Let me know what they are.
  486.  
  487.  
  488.  
  489. REVISION HISTORY
  490. ----------------
  491. 1/4/93  Version 1.0
  492.  
  493. Fixed bug reading CONTROL.DAT file created by QMAIL.  Added support
  494. for QWK packets with extensions QW1, QW2, etc.  Thanks to Helge
  495. Helgesen for reporting these bugs.  Added support for stripping Re:
  496. and (R) subject prefixes.  The PKZIP and PKUNZIP config options no
  497. longer require an explicit path name or extension.  First non-beta
  498. release.
  499.  
  500. 11/22/92  Version 0.99ß
  501.  
  502. Correctly update the PERSONAL.NDX file (really, this time!)
  503. First beta release available to the general public.
  504.  
  505. 11/15/92  Version 0.98ß
  506.  
  507. Changed the name to Qwkit (this is getting old!)  Changed tagline
  508. processing to pick a random starting point and then use taglines
  509. sequentially (this should speed things up a lot).  Don't process
  510. NEWFILES option when the same QWK packet is opened multiple times.
  511. Allow the user to specify "YOU" instead of a user name for the
  512. INCLUDE and EXCLUDE options.  Correctly update the PERSONAL.NDX file.
  513.  
  514. 10/31/92  Version 0.97ß
  515.  
  516. Fixed crash if you didn't specify any signature(s).
  517.  
  518.  
  519. 10/30/92  Version 0.96ß
  520.  
  521. Changed the name to QWKman.  Added support for OLX/SLMR mail readers.
  522. Replaced EXCLUDE_USER and EXCLUDE_SUBJECT keywords with the EXCLUDE
  523. keyword and added support for INCLUDE keyword.  The NEWFILES option
  524. will now append to the specified file.  Added support for up to 100
  525. signatures.
  526.